Reseller Identification and Validation API
Response Attributes
/searchReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | total | Number | "total": 5 | Number of pages matched based on the input | |
| 2 | page | Number | "page": 1 | Results fetched based on the input page size | |
| 3 | limit | Number | "limit": 500 | Index of the starting record in the response based on the value in request payload | |
| 4 | next | String | "next": "https://apx.cisco.com/dfm/services/reseller/v1/searchReseller?page=2&limit=500" | Flag indicating next page. If the value is null, call the service by changing the start index for incremental data. | |
| 5 | prev | Number | "prev": null | Identifies the unique record in response | |
| 6 | distiValResellerAcNo | String | "distiValResellerAcNo": "0001012511" | Unique account number assigned to each reseller | |
| 7 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Reseller Name | |
| 8 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Name | |
| 9 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Site Name | |
| 10 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Partner Site Address1 | |
| 11 | address2 | String | "address2": "" | Partner Site Address2 | |
| 12 | city | String | "city": "DUBAI" | Partner Site City | |
| 13 | state | String | "state": "" | Partner Site State | |
| 14 | postalCode | String | "postalCode": "" | Partner Site Postal Code | |
| 15 | country | String | "country": "UNITED ARAB EMIRATES" | Partner Site Country | |
| 16 | partnerSiteID | String | "partnerSiteID": "2698570" | Partner Site Id | |
| 17 | pdbBeGeoID | String | "pdbBeGeoID": "5410" | Partner begeo Id | |
| 18 | partnerType | String | "partnerType": "VAR" | Partner Type | |
| 10 | certification | String | "certification": "GOLD" | Partner Certification Attribute | |
| 20 | certEffectiveStartDate | String | "certEffectiveStartDate": "27-SEP-2022" | Partner Certification Effective Date | |
| 21 | certificationExpiryDate | String | "certificationExpiryDate": "27-SEP-2023" | Partner Certification End Date | |
| 22 | specialization | Array | "specialization": [{"specType": "AENAS","validUntil": "05-MAY-24"},{"specType": "ASAS","validUntil": "23-APR-24"}] | Partner Specialization Attribute | |
| 23 | authorization | Array | "authorization": [{"authType": "CPIA","validUntil": "12-NOV-68"},{"authType": "CSPP","validUntil": "11-FEB-24"}] | Partner Authorization Attribute | |
| 24 | registrationStatus | String | "registrationStatus": "REGISTERED" | Partner Registration Status | |
| 25 | regEffectiveStartDate | String | "regEffectiveStartDate": "12-FEB-2023" | Partner Registration Start Date | |
| 26 | registrationExpiryDate | String | "registrationExpiryDate": "11-FEB-2024" | Partner Registration End Date | |
| 27 | phoneNumber | String | "phoneNumber": "0097143972220" | Partner Site Contact | |
| 28 | website | String | "website": "WWW.ITS.WS" | Partner WebAddress |
/gdvrResellers
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | total | Number | "total": 5 | Number of records matched based on the input | |
| 2 | page | Number | "page": 1 | Results fetched based on the input page size | |
| 3 | limit | Number | "limit": 500 | Index of the starting record in the response based on the value in request payload | |
| 4 | next | String | "next": "https://apx.cisco.com/dfm/services/reseller/v1/gdvrResellers?page=2&limit=500" | Flag indicating next page. If the value is null, call the service by changing the start index for incremental data. | |
| 5 | prev | Number | "prev": null | Identifies the unique record in response | |
| 6 | partnerName | String | "partnerName": "PARTNER NAME" | Name of the Partner | |
| 7 | beGeoID | String | "beGeoID": "123456" | Partner Begeo Id | |
| 8 | partnerSiteId | String | "partnerSiteId": "98749" | Partner Site Id | |
| 9 | address | String | "address": "Street Address 1" | Partner Site Address1 | |
| 10 | city | String | "city": "Morrisville" | Partner Site City | |
| 11 | state | String | "state": "NC" | Partner Site State | |
| 12 | country | String | "country": "USA" | Partner Site Country | |
| 13 | postalCode | String | "postalCode": "27703" | Partner Site Postal Code | |
| 14 | webAddress | String | "webAddress": "WWW.webaddress.com" | Partner WebAddress | |
| 15 | list | String | "list": ["DNR","DPL"] | Reseller denial type |
/addReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Name | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique account number assigned to each reseller | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Reseller Name | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Name | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Site Name | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Partner Site Address1 | |
| 7 | address2 | String | "address2": "" | Partner Site Address2 | |
| 8 | city | String | "city": "DUBAI" | Partner Site City | |
| 9 | state | String | "state": "" | Partner Site State | |
| 10 | postalCode | String | "postalCode": "" | Partner Postal Code | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Request Description | |
| 12 | responseStatus | String | "responseStatus": "success" | Service Response Status | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Service Response Message |
/updateReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Name | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique account number assigned to each reseller | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Reseller Name | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Name | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Site Name | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Partner Site Address1 | |
| 7 | address2 | String | "address2": "" | Partner Site Address2 | |
| 8 | city | String | "city": "DUBAI" | Partner Site City | |
| 9 | state | String | "state": "" | Partner Site State | |
| 10 | postalCode | String | "postalCode": "" | Partner Site Postal Code | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Request Description | |
| 12 | responseStatus | String | "responseStatus": "success" | Service Response Status | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Service Response Message |
/deleteReseller
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | distiName | String | "distiName": "xyz disti name" | Distributor Name | |
| 2 | distiValResellerAcNo | String | "distiValResellerAcctNo": "123455" | Unique account number assigned to each reseller | |
| 3 | distiValSoldToName | String | "distiValSoldToName": "INTERNATIONAL TURNKEY SYSTEMS" | Reseller Name | |
| 4 | partnerName | String | "partnerName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Name | |
| 5 | partnerSiteName | String | "partnerSiteName": "INTERNATIONAL TURNKEY SYSTEMS" | Partner Site Name | |
| 6 | address1 | String | "address1": "NATIONAL BANK OF UMM AL-QAIWAIN BLDGBUR DUBAI" | Partner Site Address1 | |
| 7 | address2 | String | "address2": "" | Partner Site Address2 | |
| 8 | city | String | "city": "DUBAI" | Partner Site City | |
| 9 | state | String | "state": "" | Partner Site State | |
| 10 | postalCode | String | "postalCode": "" | Partner Site Postal Code | |
| 11 | requestDescription | String | "requestDescription": "ADD" | Request Description | |
| 12 | responseStatus | String | "responseStatus": "success" | Service Response Status | |
| 13 | responseMessage | String | "responseMessage": "Reseller information added successfully" | Service Response Message |
/getSourceNames
Method: GET
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | ccoId | String | "ccoId": "myCCodID@email.com" | CCO ID Used to Register Application for API Access | |
| 2 | sourceName | String | "sourceName": "Distri Name 1" | Disti Name | |
| 2 | theaterCode | String | "theaterCode": "EMEA" | Theater Code Associated with the Disti Name |